home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 6 / The Arsenal Files 6 (Arsenal Computer).ISO / ra / dctbg112.exe / DCTNEWS.TXT < prev    next >
Encoding:
Text File  |  1996-01-13  |  19.3 KB  |  368 lines

  1.  
  2.  
  3.                         DCT Bulletin Generator v1.12
  4.                             By Daniel Traczynski
  5.                               January 13, 1996
  6.  
  7.           Copyright (C) 1995..96 Dan Traczynski.  All rights reserved.
  8.  
  9.  
  10.  
  11. ╔═════════════════════════════════╗╒══════════════════════════════╕╒═════════╕
  12. ║ Table of Contents               ║│ DCT Bulletin Generator v1.12 ││ Part  1 │
  13. ╙─────────────────────────────────╜└──────────────────────────────┘└─────────┘
  14.  
  15.  
  16.                        1..Table of Contents
  17.                        2..Introduction
  18.                        3..Installation & Requirements
  19.                        4..General Program Usage
  20.                        5..Using Imbedded Codes
  21.                        6..Creating Custom Bulletin Styles
  22.                        7..Support
  23.                        8..Enhanced Mode
  24.                        9..Credits/Acknowledgments
  25.                       10..Distribution and Disclaimer
  26.                       11..History
  27.  
  28. ╔═════════════════════════════════╗╒══════════════════════════════╕╒═════════╕
  29. ║ Introduction                    ║│ DCT Bulletin Generator v1.12 ││ Part  2 │
  30. ╙─────────────────────────────────╜└──────────────────────────────┘└─────────┘
  31.  
  32.     The DCT Bulletin Generator is like all of the other generators that
  33.  exist, except that this one is better, :) and will create beautiful ANSI
  34.  news screens to show to your users when they log on to your BBS.  The
  35.  Bulletin Generator contains features like a built-in editor (with external
  36.  editors supported), complete customization, and also allows you to design
  37.  your own bulletin style, or use one of the 9 pre-made designs supplied in
  38.  the package.  Best of all, this program is freeware. ;)
  39.  
  40. ╔═════════════════════════════════╗╒══════════════════════════════╕╒═════════╕
  41. ║ Installation & Requirements     ║│ DCT Bulletin Generator v1.12 ││ Part  3 │
  42. ╙─────────────────────────────────╜└──────────────────────────────┘└─────────┘
  43.  
  44.     If you are upgrading from v1.10, simply run 110TO112.EXE and the files
  45.  will be converted to the new format.  If for some reason the upgrade fails,
  46.  delete DCTNEWS.CFG and it will be re-created when you run DCTNews.  Be sure
  47.  to re-compile the bulletins into NEWS.ANS/ASC for the changes in this
  48.  version to take effect.
  49.  
  50.     The program has only been tested with RemoteAccess, SuperBBS and Concord,
  51.  but should work with any BBS software that displays the NEWS.ANS/ASC file at
  52.  login.  To install the program, run DCTNEWS.EXE, and answer the questions
  53.  asked.  All of the required files will be created at this time.  If you ever
  54.  wish to change your configuration, edit the file DCTNEWS.CFG with any ASCII
  55.  editor, and change the lines so that they have the information displayed
  56.  below.  The default configuration should be sufficient though.
  57.  
  58.         Line 1: Real name of the Sysop (maximum 20 characters).
  59.         Line 2: BBS Name (maximum 24 characters).
  60.         Line 3: Enhancement code.  See section 8 for more information.
  61.         Line 4: Sysop name, as it will appear at the end of each bulletin.
  62.         Line 5: Directory where the text files are stored.
  63.         Line 6: Name of bulletin file to create.
  64.         Line 7: Put a "1" if you don't want users to be able to press the
  65.                 <S> key before the bulletin has been completely displayed;
  66.                 otherwise use a "0".
  67.         Line 8: If you want to have the "Today's date is..." displayed at the
  68.                 top of the screen, set this to a "1".  Otherwise set it to a 
  69.                 zero.
  70.         Line 9: If you would like to have a "Press Enter" prompt after each
  71.                 bulletin is displayed, set this to a "1".  Otherwise use "0"
  72.                 for the default format.
  73.        Line 10: File name of an external editor.
  74.  
  75.     Instructions are included in the configuration file, in case you forget
  76.  what to put on each line.  Line 6 was put in so that users can't hit the <S>
  77.  key without reading your bulletins.  It adds the ^B character to the
  78.  beginning of the file, which is the character that RA, SuperBBS, and Concord
  79.  use to disable aborting with the <S> key.  I would recommend that you allow
  80.  your users to be able to abort reading the bulletins, unless you write new
  81.  bulletins very frequently.  This option may not work on all BBS programs.
  82.  
  83.     To change the output file name from the default of NEWS.ANS/ASC, you may
  84.  enter the alternate file name on line 6.  One possibility is to name it
  85.  ONCEONLY.ANS/ASC, and the news file will only be shown once to each user
  86.  until it is updated again.  Please keep in mind that you must specify only
  87.  the file name, not the extension of .ANS or .ASC.  Also note that the output
  88.  file name is usually referred to as "NEWS.ANS/ASC" throughout this file,
  89.  even though it may not be set to that.
  90.  
  91.     If you would like to use an external editor, its file name must be
  92.  entered on line 8.  If the MS-DOS Editor were used, an "EDIT" would be typed
  93.  on this line.  If when entering a bulletin, you see a "Bad command or file
  94.  name" message appear after typing in the subject, the editor was not in the
  95.  current directory or path.  Leave this configuration line blank to use the
  96.  internal editor (preferred method).
  97.  
  98.     If the external editor is used, any lines after the nineteenth will be
  99.  ignored, and each line will be trimmed to 76 characters (excluding colour
  100.  codes) if they are longer than that.
  101.  
  102.     If the file DCTNEWS.HDR exists in the current directory, it will be
  103.  added to the beginning of NEWS.ANS/ASC.  The file can be up to 640 bytes,
  104.  and cannot contain any ANSI codes.  If they do exist, they will be filtered
  105.  out during compilation.  If you wish to add colours to your header, you must
  106.  follow the instructions in section 5 of this manual.
  107.  
  108. ╔═════════════════════════════════╗╒══════════════════════════════╕╒═════════╕
  109. ║ General Program Usage           ║│ DCT Bulletin Generator v1.12 ││ Part  4 │
  110. ╙─────────────────────────────────╜└──────────────────────────────┘└─────────┘
  111.  
  112.     Type DCTNEWS to start the program, and make sure that the configuration
  113.  file is in the current directory.  To add a new bulletin, press 1.  Enter
  114.  the subject that it is about, and you will then have 19 lines for your
  115.  bulletin.  Pressing <F1> will bring up a summary of the available commands,
  116.  so there is really no need to list them here.  
  117.  
  118.     If you wish to trim down the number of entries in the News File, press 2.
  119.  You will be asked as to how many News Items that you would like to have
  120.  remaining, and it will keep the newest entries only.  Entering 0 or hitting
  121.  <Esc> will abort.  The remaining entries will be automatically compiled into
  122.  the NEWS.ANS/ASC files.
  123.  
  124.     To see what the bulletin style looks like, press 3 when in the main menu.
  125.  If you would like to shell to DOS quickly to do something, hit 5 from the
  126.  main menu.  Once you have finished using the program, hit 6 or <Esc> to
  127.  quit.
  128.  
  129.     There is no way (yet) to edit bulletins that have already been added to
  130.  the News File from within the program.  If you wish to do this, use any
  131.  ASCII editor and edit the DCTNEWS.DAT file.  Below is a description of how
  132.  this works.
  133.  
  134.           :Test                       This is the subject.
  135.           May06-95                    This is the date of the entry.       
  136.           This is a test bulletin.    Actual bulletin.
  137.           ^                           This will echo a CR/LF in NEWS.ANS/ASC.
  138.           The above line is blank.    More of the bulletin.
  139.                                       Blank lines are ignored.
  140.           :Testing...                 All bulletins must begin with a ":".
  141.           May03-95                    Date.
  142.           .                           .
  143.           .                           .
  144.           etc.                        etc.
  145.  
  146.     The description isn't very good, but if you create a News Item, then edit
  147.  it, you should understand how it works.  The newest bulletins must go first,
  148.  and all of the News Items start with a colon.  Never start any other part of
  149.  the bulletin with a colon, or the program may get confused and create
  150.  garbage.  Once you have finished editing the data file, choose option 5 in
  151.  the main menu to re-compile it into the NEWS.ANS/ASC files.
  152.  
  153. ╔═════════════════════════════════╗╒══════════════════════════════╕╒═════════╕
  154. ║ Using Imbedded Codes            ║│ DCT Bulletin Generator v1.12 ││ Part  5 │
  155. ╙─────────────────────────────────╜└──────────────────────────────┘└─────────┘
  156.  
  157.     Imbedded codes may be used in almost all strings and data files.  When a
  158.  string or file is checked, any imbedded codes within it are converted into
  159.  new strings.  Valid codes are shown below.
  160.  
  161.        `XX  Changes the colour to "XX".  The first character is the fore-
  162.             ground colour, and the second is the background.  These are valid
  163.             colour codes.
  164.  
  165.                   0 - Black       8 - Grey
  166.                   1 - Blue        9 - Bright Blue
  167.                   2 - Green       A - Bright Green
  168.                   3 - Cyan        B - Bright Cyan
  169.                   4 - Red         C - Bright Red
  170.                   5 - Violet      D - Bright Magenta
  171.                   6 - Brown       E - Yellow
  172.                   7 - White       F - Bright White
  173.                   X - No change (can be used for foreground and background)
  174.  
  175.             The background colour may only be from 0 to 7.  For example, to
  176.             change blue on white to bright blue on white, then to bright
  177.             red on blue, and finally to normal green on white again, it would
  178.             look like this:
  179.  
  180.                                                    `17`9X`C1`27
  181.                                                     ┬  ┬  ┬  ┬
  182.                        Change to blue on white ─────┘  │  │  │
  183.                        Change to bright blue on white ─┘  │  │
  184.                        Change to bright red on blue ──────┘  │
  185.                        Change to normal green on white ──────┘
  186.  
  187.         |D  This is converted to the date that the bulletin was generated.
  188.         |V  Displays the version of the Bulletin Generator.
  189.         |B  Displays the BBS Name.  It is always 24 characters long.
  190.  
  191. ╔═════════════════════════════════╗╒══════════════════════════════╕╒═════════╕
  192. ║ Creating Custom Bulletin Styles ║│ DCT Bulletin Generator v1.12 ││ Part  6 │
  193. ╙─────────────────────────────────╜└──────────────────────────────┘└─────────┘
  194.  
  195.     When designing a bulletin style, the template file DCTNEWS.STL must first
  196.  be created, and can be no larger than 512 bytes.  The format is as follows.
  197.  
  198.    Line 1: `X0            The colour that the bulletin text will be.  The
  199.                           background colour MUST be black.
  200.    Line 2: nn             The maximum length of the subject (can be 20-62).
  201.    Line 3: Press Enter    What the "Press Enter" prompt at the end will look
  202.                           like.  If this is less than 10 characters long, a
  203.                           random prompt will be selected.
  204.    Line 4: n              What the background colour of the title bar at the
  205.                           top of NEWS.ANS will be (1-7, 0 disables).
  206.    Line 5: XXXXXXXXXX     What the style looks like.
  207.    Line 6: XXXXXXXXXX     Another line of the bulletin style.
  208.              .                   .
  209.              .                   .
  210.              .                   .
  211.             etc.                etc.
  212.  
  213.   In addition to the codes explained in section 5, these ones may also be
  214.   used within DCTNEWS.STL.
  215.  
  216.         |L  This expands to show the subject of the bulletin.  The subject
  217.             text is left-justified, and it is always the length specified on
  218.             line 2 of DCTNEWS.STL.
  219.         |R  Same as above, except that the subject text is right-justified.
  220.         |S  Also expands to the subject, but does not include the extra
  221.             spacebar padding that make the above functions always the same
  222.             length.
  223.         |D  This is converted to the date of the bulletin.  It is always
  224.             eight characters long.
  225.  
  226.         !x  Displays the character "x" as long as the length of the subject;
  227.             so if the subject were ten characters long, it would be expanded
  228.             to 10 x's.
  229.  
  230.         @x  This shows the character "x" as long as the maximum subject
  231.             length minus the actual length of the subject.  Therefore, if the
  232.             maximum subject length was 62 characters, and the subject was 30
  233.             characters long, "x" would be displayed 42 times.
  234.  
  235.     For examples of the above information, please take a look at the files
  236.  within the self-extracting archive SAMPLES.EXE that came with this program.
  237.  
  238. ╔═════════════════════════════════╗╒══════════════════════════════╕╒═════════╕
  239. ║ Support                         ║│ DCT Bulletin Generator v1.12 ││ Part  7 │
  240. ╙─────────────────────────────────╜└──────────────────────────────┘└─────────┘
  241.  
  242.     None.  I don't have a BBS, so I can't really be contacted in any way.  If
  243.  you do know how to get in touch with me, though, I'll be happy to answer any
  244.  questions that you may have, or listen to your suggestions or bug reports.
  245.  I would also be interested in knowing if this program works on any BBS
  246.  programs other than RemoteAccess, SuperBBS, and Concord.  I am also looking
  247.  for a support BBS for my programs.  (So if anyone is interested...)
  248.  
  249. ╔═════════════════════════════════╗╒══════════════════════════════╕╒═════════╕
  250. ║ Enhanced Mode                   ║│ DCT Bulletin Generator v1.12 ││ Part  8 │
  251. ╙─────────────────────────────────╜└──────────────────────────────┘└─────────┘
  252.  
  253.     The program is freeware, however, it will now support an "enhanced" mode.
  254.  This basically means that if you send me a "donation" for my work in making
  255.  this program, I will send you a code that will enable the enhanced mode.
  256.  Registration is not required, though, and there are no unregistered delays,
  257.  beeps, or messages telling you to pay.  You simply get a few bonus features
  258.  by sending me money. :)
  259.  
  260.     The following bonus features will only work in the enhanced mode.
  261.  
  262.         -Forcing users to read the bulletin.
  263.         -Turning off the "Today's date is..." option.
  264.         -Maximum subject length may be changed.
  265.         -The BBS name is displayed at the top of NEWS.ANS/ASC instead of
  266.          "[FREEWARE]".
  267.         -The colour of the title bar at the top of NEWS.ANS/ASC can be
  268.          changed or the bar can be removed altogether.
  269.         -Shell to DOS is enabled.
  270.         -A "This copy is registered to xxx of xxx BBS" is added to the
  271.          end of the bulletin.
  272.         -And any more new features that I add in the next version.
  273.  
  274. ╔═════════════════════════════════╗╒══════════════════════════════╕╒═════════╕
  275. ║ Credits/Acknowledgments         ║│ DCT Bulletin Generator v1.12 ││ Part  9 │
  276. ╙─────────────────────────────────╜└──────────────────────────────┘└─────────┘
  277.  
  278.  -Garfield of Neural Meltdown BBS (604-255-5198) for testing the program for
  279.   me on SuperBBS (and I wouldn't have found out about that 80 character bug
  280.   without his ßeta testing).  Thanks! :)
  281.  -Chronos of Rogue's Inn BBS (604-924-0783) because his BBS is cool and I
  282.   thought I should mention it here. ;)
  283.  -Kevin Boldt of Expressions BBS, because I got the sample style #8 from
  284.   him.  Unfortunately, his BBS was shut down. :(
  285.  -Al Ianson of Al's Place BBS (604-xxx-xxxx) for being the first person to
  286.   register DCTNews.  Thank you very much.
  287.  
  288. ╔═════════════════════════════════╗╒══════════════════════════════╕╒═════════╕
  289. ║ Distribution & Disclaimer       ║│ DCT Bulletin Generator v1.12 ││ Part 10 │
  290. ╙─────────────────────────────────╜└──────────────────────────────┘└─────────┘
  291.  
  292.     DCTNews is copyright (C) 1995, 1996 by Daniel Traczynski.  All rights
  293.  reserved.  I encourage you to distribute it, but DO NOT change any of the
  294.  files within the original archive.  No fees are to be charged to people who
  295.  wish to obtain a copy of this program, except for general access fees to the
  296.  system.  The archive should also be named DCTBG112.EXE, preferably in LHA's
  297.  self-extracting archive format.
  298.  
  299.     The author, Daniel Traczynski, will take no responsibility to anything
  300.  that this program may or may not do to your system.  Although the program
  301.  has been tested thoroughly, no guarantee can be given that it will do what
  302.  it was made to do.  Nevertheless, if anything should happen, the user is
  303.  totally responsible, and the author will be under no obligations whatsoever.
  304.  By using this program you agree to this disclaimer.
  305.  
  306.  
  307. ╔═════════════════════════════════╗╒══════════════════════════════╕╒═════════╕
  308. ║ History                         ║│ DCT Bulletin Generator v1.12 ││ Part 11 │
  309. ╙─────────────────────────────────╜└──────────────────────────────┘└─────────┘
  310.  
  311.  + Added a new feature/Something was improved.
  312.  - Removed something.
  313.  * General comment.
  314.  > Bug fix.
  315.  
  316.   Version 1.12 - January 13, 1996.
  317.       > Fixed the runtime errors that were resulting when there was no BBS
  318.         name, Sysop name, or signature defined in DCTNEWS.CFG.
  319.       + DCTNews will now allow you to disable the signature that's appended
  320.         at the end of each bulletin.  This was actually an option in v1.10,
  321.         but the above bug wouldn't allow it to be turned off.
  322.       + The colour of the title bar at the top of NEWS.ANS/ASC may be now be
  323.         changed or the bar can be removed altogether.
  324.       > Fixed the runtime error you would get if DCTNEWS.CFG was a 0 byte
  325.         file (why would this ever happen anyway?).
  326.       + Added an option to have the BBS prompt the user to press Enter after
  327.         each bulletin is displayed.
  328.  
  329.   Version 1.10 - December 16, 1995.
  330.       * First public release.
  331.       > Fixed a bug where if a line was 80 characters long, the cursor would
  332.         move back to the beginning of the line on some terminal programs
  333.         instead of advancing to the next one.
  334.       * Moved the "Press Enter" prompt string into DCTNEWS.STL, as it made
  335.         more sense to have it there.
  336.       + Re-wrote the main menu, so that it looks really cool and has a
  337.         lightbar selector as well as hotkeys.
  338.       + Completely re-wrote the internal editor, so that the Home, End, Ins,
  339.         Del, etc. keys may also be used.  Also added a "BigFont", though it
  340.         hasn't been fully implemented yet.
  341.       + The maximum subject length can be changed, to allow more diversity
  342.         in the bulletin styles.
  343.       + Colour codes can now be used in all parts of the bulletin except the
  344.         subject.
  345.       + Colour codes have been completely re-written, so that they are
  346.         easier to understand, and so that the background colour can be
  347.         changed too.
  348.       + The compiled ANSI file is a little smaller now, as I've optimised
  349.         the ANSI routines so that they no longer add repetetive colour
  350.         changing commands.
  351.       + Shell to DOS added.
  352.       + Added ASCII support (why?).
  353.       + Improved the installation process a bit.
  354.  
  355.   Version 1.02 - May 6, 1995.
  356.       > Fixed a nasty little bug where if you entered two bulletins in a
  357.         row, the bulletin text would still be there from the first one.
  358.       + Option to create custom bulletin styles added.
  359.  
  360.   Version 1.01 - April 15, 1995.
  361.       + An external editor is now supported when entering a bulletin.
  362.       + Some internal changes.
  363.       + The cursor now looks normal, instead of a flashing underscore
  364.         character.
  365.  
  366.   Version 1.00 - April 6, 1995.
  367.       * Initial creation.
  368.